lombok

✒️ 2025-06-19 15:15 내용 수정

Java Getter와 Setter 자동 작성 라이브러리

공식 사이트 : https://projectlombok.org/
lombok을 사용하면 getter, setter 등의 메소드를 source - generate getters/setters 보다 더 쉽게 만들 수 있다.
Lombok을 사용하여 코드를 refactoring할 수 있다.
- refactoring : 코드의 기능에 변함 없이 코드의 구조 또는 성능을 개선하는 작업이다.

lombok annotation

@	설명
@Getter	getter 생성
@Setter	setter 생성
@NoArgsConstructor	파라미터가 없는 기본 생성자 생성
@AllArgsConstructor	모든 필드 값을 파라미터로 받는 생성자 생성
@RequiredArgsConstructor	final이나 @NonNull인 필드 값만 파라미터로 받는 생성자 생성
@Data	@Getter, @Setter, @RequiredArgsConstructor, @ToString, @EqualsAndHashCode 생성

설치

https://projectlombok.org/download 사이트에 접속하여 파일을 다운 받는다.

다운 받은 lombok.jar 파일을 실행한다. 실행하면 IDE를 찾을 수 없어, 이미 설치 되어 있는 IDE의 위치를 지정해 달라고 뜬다.

lombok 1.png

Specify location을 누른다.

lombok 2.png

eclipse.exe 를 찾아 선택해준다.

lombok 3.png

체크 박스가 체크 되어 있는지 확인하고, Install/Update를 누른다.

lombok 4.png

Install successful이 뜨면 Quit Installer를 누른다.

lombok 5.png

Eclipse에서 사용할 때

Eclipse에서 src/main/webapp/WEB-INF/lib 폴더에 lombok.jar 파일을 복사한다.

lombok 6.png

테스트용 클래스를 만들고, annotation으로 @Data를 입력하고 Ctrl + space를 눌러 lombok을 import한다.

lombok 7.png

클래스 내부에는 변화가 없어 보인다. 실제로 추가된 것이 있는지 확인하기 위해 상단 메뉴바에서 Window - Show View - Outline을 누른다.

lombok 8.png

우측에서 보면 getter, setter, hashCode, toString 등의 메소드가 자동으로 생성된 것을 볼 수 있다.
- 만약 보이지 않는다면 Eclipse를 한 번 껐다가 다시 켠 후 import를 다시 해준다.

lombok 9.png

Spring에서 사용할 때

다운 받은 lombok.jar를 sts.exe가 있는 폴더에 넣는다.

lombok-spring 1.png

lombok.jar를 실행해서 STS.exe를 찾아 Install / Update를 해준다.

lombok-spring 2.png
lombok-spring 3.png

pom.xml에도 lombok 라이브러리를 등록해준다.
- https://mvnrepository.com/artifact/org.projectlombok/lombok/1.18.30 에서 Maven 작성용 코드를 복사할 수 있다.

<dependencies>
	<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
	<dependency>
	    <groupId>org.projectlombok</groupId>
	    <artifactId>lombok</artifactId>
	    <version>1.18.30</version>
	    <scope>provided</scope>
	</dependency>
</dependencies>

lombok spring 4.png